/**
 * This file is part of JNotifyOSD.
 *
 * JNotifyOSD is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JNotifyOSD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with JNotifyOSD. If not, see <http://www.gnu.org/licenses/>.
 */

package notifyosd;

/**
 * Handler for a On-screen notification
 * @author Giulio Franco <g.franco9@studenti.unisa.it>
 */
public interface Notification {
    public static enum Urgency {
        LOW,
        NORMAL,
        CRITICAL;
    };
    
    /**
     * Gets the text
     * @return Text of the notification
     */
    String getBody();
    
    /**
     * Sets the text
     * @param body New text for the notification
     */
    void setBody(String body);
    
    /**
     * Gets the category
     * @return Category of the notification
     */
    String getCategory();
    
    /**
     * Sets the category
     * @param category New category
     */
    void setCategory(String category);
    
    /**
     * Gets the icon
     * @return Path of the icon
     */
    String getIcon();
    
    /**
     * Sets the icon
     * @param icon Path of the new icon
     */
    void setIcon(String icon);
    
    /**
     * Gets the timeout
     * @return Time the notification should be displayed for (milliseconds)
     */
    int getTimeout();
    
    /**
     * Sets the timeout
     * @param timeout Time the notification should be displayed for (millisec.)
     */
    void setTimeout(int timeout);
    
    /**
     * Gets the title
     * @return Title of the notification
     */
    String getTitle();
    
    /**
     * Sets the title
     * @param title Title of the notification
     * @throws NullPointerException if title is null
     */
    void setTitle(String title);
    
    /**
     * Gets the urgency
     * @return Urgency of the notification
     */
    Urgency getUrgency();
    
    /**
     * Sets the urgency
     * @param urgency Urgency of the notification
     */
    void setUrgency(Urgency urgency);
    
    /**
     * Displays the notification
     * The notification will be hidden automatically
     * after at most {@link #getTimeout()} milliseconds.
     */
    void show();
    
    /**
     * Hides the notification.
     */
    void hide();
}
